<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Biometric Embedded Platform: api/inc/fpc_bep_types.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Biometric Embedded Platform
   &#160;<span id="projectnumber">fpc_bep_kaadas_21.0.1.002</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('fpc__bep__types_8h.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#enum-members">Enumerations</a>  </div>
  <div class="headertitle">
<div class="title">fpc_bep_types.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Biometric Embedded Platform types.  
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;stdbool.h&gt;</code><br />
</div>
<p><a href="fpc__bep__types_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:aac8124c8124fff6434f4442baa231459"><td class="memItemLeft" align="right" valign="top"><a id="aac8124c8124fff6434f4442baa231459"></a>
typedef struct fpc_bep_image&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fpc__bep__types_8h.html#aac8124c8124fff6434f4442baa231459">fpc_bep_image_t</a></td></tr>
<tr class="memdesc:aac8124c8124fff6434f4442baa231459"><td class="mdescLeft">&#160;</td><td class="mdescRight">Image used to store a captured image. <br /></td></tr>
<tr class="separator:aac8124c8124fff6434f4442baa231459"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa5f53a6c77b54a8f592f9c81480e79a5"><td class="memItemLeft" align="right" valign="top"><a id="aa5f53a6c77b54a8f592f9c81480e79a5"></a>
typedef struct fpc_bep_sensor&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fpc__bep__types_8h.html#aa5f53a6c77b54a8f592f9c81480e79a5">fpc_bep_sensor_t</a></td></tr>
<tr class="memdesc:aa5f53a6c77b54a8f592f9c81480e79a5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sensor. <br /></td></tr>
<tr class="separator:aa5f53a6c77b54a8f592f9c81480e79a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:adf46f9c3966202d9cf52a82981adaea4"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4">fpc_bep_result_t</a> { <br />
&#160;&#160;<a class="el" href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4aee87626898fbfd622671a03b35f12ddc">FPC_BEP_RESULT_OK</a> = 0, 
<br />
&#160;&#160;<a class="el" href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4a853d1e690e912e7f7738ca82717dee4b">FPC_BEP_RESULT_GENERAL_ERROR</a> = -1, 
<br />
&#160;&#160;<a class="el" href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4a7c79faff4a13f087af5d1ad247577570">FPC_BEP_RESULT_INTERNAL_ERROR</a> = -2, 
<br />
&#160;&#160;<a class="el" href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4ab73ef6ea129b50e5555e66759cfb1aed">FPC_BEP_RESULT_INVALID_ARGUMENT</a> = -3, 
<br />
&#160;&#160;<a class="el" href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4ab20c608bef4feb912be5fb6083619461">FPC_BEP_RESULT_NOT_IMPLEMENTED</a> = -4, 
<br />
&#160;&#160;<a class="el" href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4a7d84a83ac06904dc5d613c19057c0bf6">FPC_BEP_RESULT_CANCELLED</a> = -5, 
<br />
&#160;&#160;<a class="el" href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4ad4ffd1ec3731d32b970a669bb77fdd34">FPC_BEP_RESULT_NO_MEMORY</a> = -6, 
<br />
&#160;&#160;<a class="el" href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4a4a73f08108b40087f6345ef5e57bbe81">FPC_BEP_RESULT_NO_RESOURCE</a> = -7, 
<br />
&#160;&#160;<a class="el" href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4a52b25fd6bf8b1a591740ee82d61f3d12">FPC_BEP_RESULT_IO_ERROR</a> = -8, 
<br />
&#160;&#160;<a class="el" href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4a172d674af7c82c8e349dae6fd4db050f">FPC_BEP_RESULT_BROKEN_SENSOR</a> = -9, 
<br />
&#160;&#160;<a class="el" href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4af766cc66419c840a162f0db60a6416e6">FPC_BEP_RESULT_WRONG_STATE</a> = -10, 
<br />
&#160;&#160;<a class="el" href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4a35581ee1aec698a56bc68b26e800cd60">FPC_BEP_RESULT_TIMEOUT</a> = -11, 
<br />
&#160;&#160;<a class="el" href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4ac3231d3bcd1952a8d8b2f20f633d4440">FPC_BEP_RESULT_ID_NOT_UNIQUE</a> = -12, 
<br />
&#160;&#160;<a class="el" href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4a3a035acb45193e42d5ec024a939fe3f0">FPC_BEP_RESULT_ID_NOT_FOUND</a> = -13, 
<br />
&#160;&#160;<a class="el" href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4a3aea22028db593f12a297804f7a3c683">FPC_BEP_RESULT_INVALID_FORMAT</a> = -14, 
<br />
&#160;&#160;<a class="el" href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4af0d4b2ad8dd8a8c9dbf00cab630ffeb3">FPC_BEP_RESULT_IMAGE_CAPTURE_ERROR</a> = -15, 
<br />
&#160;&#160;<a class="el" href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4abe553e9b2a3b26b92db3a13e11c972e6">FPC_BEP_RESULT_SENSOR_MISMATCH</a> = -16, 
<br />
&#160;&#160;<a class="el" href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4acf7cf146e115ca85f64c849fe0fb4506">FPC_BEP_RESULT_MISSING_TEMPLATE</a> = -18, 
<br />
&#160;&#160;<a class="el" href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4aeabf36b68b69ef24d090a5ec1ca10d9d">FPC_BEP_RESULT_INVALID_CALIBRATION</a> = -19, 
<br />
&#160;&#160;<a class="el" href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4a5985c8ccfe631ebb081743d6d961172e">FPC_BEP_RESULT_STORAGE_NOT_FORMATTED</a> = -20, 
<br />
&#160;&#160;<a class="el" href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4aff307a27dfb2d6e183bdd01f7afb3492">FPC_BEP_RESULT_SENSOR_NOT_INITIALIZED</a> = -21, 
<br />
&#160;&#160;<a class="el" href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4aca133611ed039051a066d85e42d9b813">FPC_BEP_RESULT_TOO_MANY_BAD_IMAGES</a> = -22, 
<br />
&#160;&#160;<a class="el" href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4a6718006bc4a66c7955ac0001c99c3176">FPC_BEP_RESULT_NOT_SUPPORTED</a> = -24, 
<br />
&#160;&#160;<a class="el" href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4a5b0ae903522b35ef2b4f1ab8ab4b6cae">FPC_BEP_RESULT_FINGER_NOT_STABLE</a> = -25, 
<br />
&#160;&#160;<a class="el" href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4ae9dcba53630d44054e74dc5ea0c2ff0b">FPC_BEP_RESULT_NOT_INITIALIZED</a> = -26, 
<br />
&#160;&#160;<a class="el" href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4a499b7fbf94bff0696d3487712938efb7">FPC_BEP_RESULT_TOO_MANY_DEAD_PIXELS</a> = -27, 
<br />
&#160;&#160;<a class="el" href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4a638c02f96cd1d266b778c0ed26f97ddc">FPC_BEP_RESULT_SECURITY_VIOLATION</a> = -28, 
<br />
&#160;&#160;<a class="el" href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4ad2b4d6ff72495c0bfdbf15153565fa93">FPC_BEP_RESULT_SENSOR_FIFO_UNDERFLOW</a> = -29, 
<br />
&#160;&#160;<a class="el" href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4aba7a352250e47b51e42e62123ef2a970">FPC_BEP_RESULT_OTP_NO_DATA</a> = -30, 
<br />
&#160;&#160;<a class="el" href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4a1ee116ad7e8d7c5c8ffac9601069d2cf">FPC_BEP_RESULT_SECURITY_CAPTURE_ERROR</a> = -31, 
<br />
&#160;&#160;<a class="el" href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4a42edcae58da6d02b7935f4434b580446">FPC_BEP_RESULT_SENSOR_IRQ_NOT_HIGH</a> = -32, 
<br />
&#160;&#160;<a class="el" href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4ada84c3d206b52e8981913831a90a1588">FPC_BEP_RESULT_SENSOR_IRQ_NOT_LOW</a> = -33
<br />
 }<tr class="memdesc:adf46f9c3966202d9cf52a82981adaea4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Common results returned by BEP functions.  <a href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:adf46f9c3966202d9cf52a82981adaea4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c9d883c6aa5a2e7f59227c6ecaaacc6"><td class="memItemLeft" align="right" valign="top"><a id="a2c9d883c6aa5a2e7f59227c6ecaaacc6"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fpc__bep__types_8h.html#a2c9d883c6aa5a2e7f59227c6ecaaacc6">fpc_bep_sensor_type_t</a> { <br />
&#160;&#160;<b>FPC_BEP_SENSOR_TYPE_UNDEFINED</b> = 0, 
<br />
&#160;&#160;<b>FPC_BEP_SENSOR_TYPE_FPC1261</b> = 10
<br />
 }<tr class="memdesc:a2c9d883c6aa5a2e7f59227c6ecaaacc6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fingerprint sensor type enumeration. <br /></td></tr>
</td></tr>
<tr class="separator:a2c9d883c6aa5a2e7f59227c6ecaaacc6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1c3740269395cfccd0aef5ac41559a6b"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fpc__bep__types_8h.html#a1c3740269395cfccd0aef5ac41559a6b">fpc_bep_finger_status_t</a> { <br />
&#160;&#160;<a class="el" href="fpc__bep__types_8h.html#a1c3740269395cfccd0aef5ac41559a6ba5c83dce54a2bbf41492348220fe408bc">FPC_BEP_FINGER_STATUS_UNDEFINED</a> = 0, 
<br />
&#160;&#160;<a class="el" href="fpc__bep__types_8h.html#a1c3740269395cfccd0aef5ac41559a6ba07df95998e03f48f2393fe595011cd61">FPC_BEP_FINGER_STATUS_PRESENT</a> = 1, 
<br />
&#160;&#160;<a class="el" href="fpc__bep__types_8h.html#a1c3740269395cfccd0aef5ac41559a6ba6eec487445b2ef2dbe5c2501911803ef">FPC_BEP_FINGER_STATUS_NOT_PRESENT</a> = 2, 
<br />
&#160;&#160;<a class="el" href="fpc__bep__types_8h.html#a1c3740269395cfccd0aef5ac41559a6ba8908f945b53b633b6e60ba0e562c89d7">FPC_BEP_FINGER_STATUS_PARTIAL</a> = 3
<br />
 }<tr class="memdesc:a1c3740269395cfccd0aef5ac41559a6b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finger present status.  <a href="fpc__bep__types_8h.html#a1c3740269395cfccd0aef5ac41559a6b">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:a1c3740269395cfccd0aef5ac41559a6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a58f034417a4e1bc9cef9137aa3aa031f"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fpc__bep__types_8h.html#a58f034417a4e1bc9cef9137aa3aa031f">fpc_bep_sensor_driver_mechanism_t</a> { <br />
&#160;&#160;<a class="el" href="fpc__bep__types_8h.html#a58f034417a4e1bc9cef9137aa3aa031fa3e90c53c3d1bd719b55d76ba61b9cadc">FPC_BEP_INTERRUPT_DRIVEN</a> = 0, 
<br />
&#160;&#160;<a class="el" href="fpc__bep__types_8h.html#a58f034417a4e1bc9cef9137aa3aa031fa66e4a6dd9f2298b114c777a8275817a0">FPC_BEP_POLLING</a> = 1
<br />
 }<tr class="memdesc:a58f034417a4e1bc9cef9137aa3aa031f"><td class="mdescLeft">&#160;</td><td class="mdescRight">FPC sensor driver mechanism.  <a href="fpc__bep__types_8h.html#a58f034417a4e1bc9cef9137aa3aa031f">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:a58f034417a4e1bc9cef9137aa3aa031f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac4da354010b9012ce2767da249de35b9"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fpc__bep__types_8h.html#ac4da354010b9012ce2767da249de35b9">fpc_bep_sensor_reset_t</a> { <br />
&#160;&#160;<a class="el" href="fpc__bep__types_8h.html#ac4da354010b9012ce2767da249de35b9a6ef0de25d7da74f58a3861c55453da3d">FPC_BEP_HARD_RESET</a> = 0, 
<br />
&#160;&#160;<a class="el" href="fpc__bep__types_8h.html#ac4da354010b9012ce2767da249de35b9a0f5403529d3469496a55aeb2cffe640f">FPC_BEP_SOFT_RESET</a> = 1
<br />
 }<tr class="memdesc:ac4da354010b9012ce2767da249de35b9"><td class="mdescLeft">&#160;</td><td class="mdescRight">FPC sensor reset type.  <a href="fpc__bep__types_8h.html#ac4da354010b9012ce2767da249de35b9">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:ac4da354010b9012ce2767da249de35b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa6e74077b38c2f61ddf287bc03c09579"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fpc__bep__types_8h.html#aa6e74077b38c2f61ddf287bc03c09579">fpc_bep_sensor_state_after_release_t</a> { <br />
&#160;&#160;<a class="el" href="fpc__bep__types_8h.html#aa6e74077b38c2f61ddf287bc03c09579aed3aaff12a171843c6c8764d4ce7718f">FPC_BEP_SENSOR_DEEP_SLEEP</a> = 0, 
<br />
&#160;&#160;<a class="el" href="fpc__bep__types_8h.html#aa6e74077b38c2f61ddf287bc03c09579a951113e4e4d7d91308aa134fdb8e6806">FPC_BEP_SENSOR_SLEEP</a> = 1, 
<br />
&#160;&#160;<a class="el" href="fpc__bep__types_8h.html#aa6e74077b38c2f61ddf287bc03c09579ae8d27b2d96c9ea3db354b9f3066d5dda">FPC_BEP_SENSOR_IDLE</a> = 2
<br />
 }<tr class="memdesc:aa6e74077b38c2f61ddf287bc03c09579"><td class="mdescLeft">&#160;</td><td class="mdescRight">FPC sensor state after BEP release.  <a href="fpc__bep__types_8h.html#aa6e74077b38c2f61ddf287bc03c09579">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:aa6e74077b38c2f61ddf287bc03c09579"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a37ee8052603322afdec6397af116d968"><td class="memItemLeft" align="right" valign="top"><a id="a37ee8052603322afdec6397af116d968"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fpc__bep__types_8h.html#a37ee8052603322afdec6397af116d968">fpc_bep_config_t</a> { <br />
&#160;&#160;<b>FPC_BEP_CONFIG_DISABLE</b> = 0, 
<br />
&#160;&#160;<b>FPC_BEP_CONFIG_ENABLE</b> = 1
<br />
 }<tr class="memdesc:a37ee8052603322afdec6397af116d968"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fingerprint common configuration type. <br /></td></tr>
</td></tr>
<tr class="separator:a37ee8052603322afdec6397af116d968"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Biometric Embedded Platform types. </p>
<p>This is the common types used by Biometric Embedded Platform (BEP) library.</p>
<dl class="section note"><dt>Note</dt><dd>This is a work-in-progress specification. Implementers are informed that this API may change without providing any backward compatibility. However it is FPC's ambition that the API shall remain compatible between releases. </dd></dl>
</div><h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a1c3740269395cfccd0aef5ac41559a6b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1c3740269395cfccd0aef5ac41559a6b">&#9670;&nbsp;</a></span>fpc_bep_finger_status_t</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="fpc__bep__types_8h.html#a1c3740269395cfccd0aef5ac41559a6b">fpc_bep_finger_status_t</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Finger present status. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a1c3740269395cfccd0aef5ac41559a6ba5c83dce54a2bbf41492348220fe408bc"></a>FPC_BEP_FINGER_STATUS_UNDEFINED&#160;</td><td class="fielddoc"><p>Undefined value </p>
</td></tr>
<tr><td class="fieldname"><a id="a1c3740269395cfccd0aef5ac41559a6ba07df95998e03f48f2393fe595011cd61"></a>FPC_BEP_FINGER_STATUS_PRESENT&#160;</td><td class="fielddoc"><p>Sufficient number of sensor sub-areas are covered </p>
</td></tr>
<tr><td class="fieldname"><a id="a1c3740269395cfccd0aef5ac41559a6ba6eec487445b2ef2dbe5c2501911803ef"></a>FPC_BEP_FINGER_STATUS_NOT_PRESENT&#160;</td><td class="fielddoc"><p>No sensor sub-areas are covered </p>
</td></tr>
<tr><td class="fieldname"><a id="a1c3740269395cfccd0aef5ac41559a6ba8908f945b53b633b6e60ba0e562c89d7"></a>FPC_BEP_FINGER_STATUS_PARTIAL&#160;</td><td class="fielddoc"><p>Sufficient number of sensor sub-areas are not covered </p>
</td></tr>
</table>

</div>
</div>
<a id="adf46f9c3966202d9cf52a82981adaea4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adf46f9c3966202d9cf52a82981adaea4">&#9670;&nbsp;</a></span>fpc_bep_result_t</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="fpc__bep__types_8h.html#adf46f9c3966202d9cf52a82981adaea4">fpc_bep_result_t</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Common results returned by BEP functions. </p>
<dl class="section user"><dt>BEP config/usage errors:</dt><dd><b>Examples:</b> Incorrect arguments/parameters when calling BEP API functions; functions called in incorrect order. <br />
 <b>Action:</b> Fix SW bug. <br />
 </dd></dl>
<dl class="section user"><dt></dt><dd>FPC_BEP_RESULT_GENERAL_ERROR <br />
 FPC_BEP_RESULT_NOT_IMPLEMENTED <br />
 FPC_BEP_RESULT_NOT_SUPPORTED <br />
 FPC_BEP_RESULT_NOT_INITIALIZED <br />
 FPC_BEP_RESULT_CANCELLED <br />
 FPC_BEP_RESULT_NO_RESOURCE <br />
 FPC_BEP_RESULT_WRONG_STATE <br />
 FPC_BEP_RESULT_ID_NOT_UNIQUE <br />
 FPC_BEP_RESULT_ID_NOT_FOUND <br />
 FPC_BEP_RESULT_INVALID_FORMAT <br />
 FPC_BEP_RESULT_INVALID_ARGUMENT <br />
 FPC_BEP_RESULT_INVALID_CALIBRATION <br />
 FPC_BEP_RESULT_MISSING_TEMPLATE <br />
 FPC_BEP_RESULT_STORAGE_NOT_FORMATTED <br />
 FPC_BEP_RESULT_SENSOR_NOT_INITIALIZED <br />
 FPC_BEP_RESULT_SENSOR_MISMATCH <br />
</dd></dl>
<dl class="section user"><dt>Dynamic memory/heap errors:</dt><dd><b>Examples:</b> Memory leak; heap is too small. <br />
 <b>Action:</b> Fix SW bug. <br />
 </dd></dl>
<dl class="section user"><dt></dt><dd>FPC_BEP_RESULT_NO_MEMORY</dd></dl>
<dl class="section user"><dt>Sensor and communication errors:</dt><dd><b>Examples:</b> Broken sensor communication lines; unstable power supply. <br />
 <b>Action:</b> Fix HW bug. <br />
 </dd></dl>
<dl class="section user"><dt></dt><dd>FPC_BEP_RESULT_BROKEN_SENSOR <br />
 FPC_BEP_RESULT_SENSOR_IRQ_NOT_HIGH <br />
 FPC_BEP_RESULT_SENSOR_IRQ_NOT_LOW <br />
 FPC_BEP_RESULT_INTERNAL_ERROR <br />
 FPC_BEP_RESULT_TIMEOUT <br />
 FPC_BEP_RESULT_IO_ERROR <br />
 FPC_BEP_RESULT_SENSOR_FIFO_UNDERFLOW</dd></dl>
<dl class="section user"><dt>Image capture errors:</dt><dd><b>Examples:</b> Finger removed from sensor too quickly. <br />
 <b>Action:</b> Call the function again. <br />
 </dd></dl>
<dl class="section user"><dt></dt><dd>FPC_BEP_RESULT_IMAGE_CAPTURE_ERROR FPC_BEP_RESULT_SECURITY_CAPTURE_ERROR </dd></dl>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="adf46f9c3966202d9cf52a82981adaea4aee87626898fbfd622671a03b35f12ddc"></a>FPC_BEP_RESULT_OK&#160;</td><td class="fielddoc"><p>No errors occurred. </p>
</td></tr>
<tr><td class="fieldname"><a id="adf46f9c3966202d9cf52a82981adaea4a853d1e690e912e7f7738ca82717dee4b"></a>FPC_BEP_RESULT_GENERAL_ERROR&#160;</td><td class="fielddoc"><p>General error. </p>
</td></tr>
<tr><td class="fieldname"><a id="adf46f9c3966202d9cf52a82981adaea4a7c79faff4a13f087af5d1ad247577570"></a>FPC_BEP_RESULT_INTERNAL_ERROR&#160;</td><td class="fielddoc"><p>Internal error. </p>
</td></tr>
<tr><td class="fieldname"><a id="adf46f9c3966202d9cf52a82981adaea4ab73ef6ea129b50e5555e66759cfb1aed"></a>FPC_BEP_RESULT_INVALID_ARGUMENT&#160;</td><td class="fielddoc"><p>Invalid argument. </p>
</td></tr>
<tr><td class="fieldname"><a id="adf46f9c3966202d9cf52a82981adaea4ab20c608bef4feb912be5fb6083619461"></a>FPC_BEP_RESULT_NOT_IMPLEMENTED&#160;</td><td class="fielddoc"><p>The functionality is not implemented. </p>
</td></tr>
<tr><td class="fieldname"><a id="adf46f9c3966202d9cf52a82981adaea4a7d84a83ac06904dc5d613c19057c0bf6"></a>FPC_BEP_RESULT_CANCELLED&#160;</td><td class="fielddoc"><p>The operation was cancelled. </p>
</td></tr>
<tr><td class="fieldname"><a id="adf46f9c3966202d9cf52a82981adaea4ad4ffd1ec3731d32b970a669bb77fdd34"></a>FPC_BEP_RESULT_NO_MEMORY&#160;</td><td class="fielddoc"><p>Out of memory. </p>
</td></tr>
<tr><td class="fieldname"><a id="adf46f9c3966202d9cf52a82981adaea4a4a73f08108b40087f6345ef5e57bbe81"></a>FPC_BEP_RESULT_NO_RESOURCE&#160;</td><td class="fielddoc"><p>Resources are not available. </p>
</td></tr>
<tr><td class="fieldname"><a id="adf46f9c3966202d9cf52a82981adaea4a52b25fd6bf8b1a591740ee82d61f3d12"></a>FPC_BEP_RESULT_IO_ERROR&#160;</td><td class="fielddoc"><p>An I/O error occurred. </p>
</td></tr>
<tr><td class="fieldname"><a id="adf46f9c3966202d9cf52a82981adaea4a172d674af7c82c8e349dae6fd4db050f"></a>FPC_BEP_RESULT_BROKEN_SENSOR&#160;</td><td class="fielddoc"><p>Sensor is broken. </p>
</td></tr>
<tr><td class="fieldname"><a id="adf46f9c3966202d9cf52a82981adaea4af766cc66419c840a162f0db60a6416e6"></a>FPC_BEP_RESULT_WRONG_STATE&#160;</td><td class="fielddoc"><p>The operation cannot be performed in the current state. </p>
</td></tr>
<tr><td class="fieldname"><a id="adf46f9c3966202d9cf52a82981adaea4a35581ee1aec698a56bc68b26e800cd60"></a>FPC_BEP_RESULT_TIMEOUT&#160;</td><td class="fielddoc"><p>The operation timed out. </p>
</td></tr>
<tr><td class="fieldname"><a id="adf46f9c3966202d9cf52a82981adaea4ac3231d3bcd1952a8d8b2f20f633d4440"></a>FPC_BEP_RESULT_ID_NOT_UNIQUE&#160;</td><td class="fielddoc"><p>The ID is not unique. </p>
</td></tr>
<tr><td class="fieldname"><a id="adf46f9c3966202d9cf52a82981adaea4a3a035acb45193e42d5ec024a939fe3f0"></a>FPC_BEP_RESULT_ID_NOT_FOUND&#160;</td><td class="fielddoc"><p>The ID is not found. </p>
</td></tr>
<tr><td class="fieldname"><a id="adf46f9c3966202d9cf52a82981adaea4a3aea22028db593f12a297804f7a3c683"></a>FPC_BEP_RESULT_INVALID_FORMAT&#160;</td><td class="fielddoc"><p>The format is invalid. </p>
</td></tr>
<tr><td class="fieldname"><a id="adf46f9c3966202d9cf52a82981adaea4af0d4b2ad8dd8a8c9dbf00cab630ffeb3"></a>FPC_BEP_RESULT_IMAGE_CAPTURE_ERROR&#160;</td><td class="fielddoc"><p>An image capture error occurred. </p>
</td></tr>
<tr><td class="fieldname"><a id="adf46f9c3966202d9cf52a82981adaea4abe553e9b2a3b26b92db3a13e11c972e6"></a>FPC_BEP_RESULT_SENSOR_MISMATCH&#160;</td><td class="fielddoc"><p>Sensor hardware id or sensor configuration mismatch. </p>
</td></tr>
<tr><td class="fieldname"><a id="adf46f9c3966202d9cf52a82981adaea4acf7cf146e115ca85f64c849fe0fb4506"></a>FPC_BEP_RESULT_MISSING_TEMPLATE&#160;</td><td class="fielddoc"><p>Missing Template. </p>
</td></tr>
<tr><td class="fieldname"><a id="adf46f9c3966202d9cf52a82981adaea4aeabf36b68b69ef24d090a5ec1ca10d9d"></a>FPC_BEP_RESULT_INVALID_CALIBRATION&#160;</td><td class="fielddoc"><p>Invalid Calibration. </p>
</td></tr>
<tr><td class="fieldname"><a id="adf46f9c3966202d9cf52a82981adaea4a5985c8ccfe631ebb081743d6d961172e"></a>FPC_BEP_RESULT_STORAGE_NOT_FORMATTED&#160;</td><td class="fielddoc"><p>Calibration/template storage not formatted. </p>
</td></tr>
<tr><td class="fieldname"><a id="adf46f9c3966202d9cf52a82981adaea4aff307a27dfb2d6e183bdd01f7afb3492"></a>FPC_BEP_RESULT_SENSOR_NOT_INITIALIZED&#160;</td><td class="fielddoc"><p>Sensor hasn't been initialized. </p>
</td></tr>
<tr><td class="fieldname"><a id="adf46f9c3966202d9cf52a82981adaea4aca133611ed039051a066d85e42d9b813"></a>FPC_BEP_RESULT_TOO_MANY_BAD_IMAGES&#160;</td><td class="fielddoc"><p>Enroll fail after too many bad images. </p>
</td></tr>
<tr><td class="fieldname"><a id="adf46f9c3966202d9cf52a82981adaea4a6718006bc4a66c7955ac0001c99c3176"></a>FPC_BEP_RESULT_NOT_SUPPORTED&#160;</td><td class="fielddoc"><p>The functionality is not supported. </p>
</td></tr>
<tr><td class="fieldname"><a id="adf46f9c3966202d9cf52a82981adaea4a5b0ae903522b35ef2b4f1ab8ab4b6cae"></a>FPC_BEP_RESULT_FINGER_NOT_STABLE&#160;</td><td class="fielddoc"><p>Finger not stable. </p>
</td></tr>
<tr><td class="fieldname"><a id="adf46f9c3966202d9cf52a82981adaea4ae9dcba53630d44054e74dc5ea0c2ff0b"></a>FPC_BEP_RESULT_NOT_INITIALIZED&#160;</td><td class="fielddoc"><p>The functionality could not be used before it's initialized. </p>
</td></tr>
<tr><td class="fieldname"><a id="adf46f9c3966202d9cf52a82981adaea4a499b7fbf94bff0696d3487712938efb7"></a>FPC_BEP_RESULT_TOO_MANY_DEAD_PIXELS&#160;</td><td class="fielddoc"><p>Number of dead pixels is over limit. </p>
</td></tr>
<tr><td class="fieldname"><a id="adf46f9c3966202d9cf52a82981adaea4a638c02f96cd1d266b778c0ed26f97ddc"></a>FPC_BEP_RESULT_SECURITY_VIOLATION&#160;</td><td class="fielddoc"><p>Data integrity violation is detected. </p>
</td></tr>
<tr><td class="fieldname"><a id="adf46f9c3966202d9cf52a82981adaea4ad2b4d6ff72495c0bfdbf15153565fa93"></a>FPC_BEP_RESULT_SENSOR_FIFO_UNDERFLOW&#160;</td><td class="fielddoc"><p>FIFO underflow error during capture. </p>
</td></tr>
<tr><td class="fieldname"><a id="adf46f9c3966202d9cf52a82981adaea4aba7a352250e47b51e42e62123ef2a970"></a>FPC_BEP_RESULT_OTP_NO_DATA&#160;</td><td class="fielddoc"><p>OTP memory is empty. </p>
</td></tr>
<tr><td class="fieldname"><a id="adf46f9c3966202d9cf52a82981adaea4a1ee116ad7e8d7c5c8ffac9601069d2cf"></a>FPC_BEP_RESULT_SECURITY_CAPTURE_ERROR&#160;</td><td class="fielddoc"><p>Security related capture error. </p>
</td></tr>
<tr><td class="fieldname"><a id="adf46f9c3966202d9cf52a82981adaea4a42edcae58da6d02b7935f4434b580446"></a>FPC_BEP_RESULT_SENSOR_IRQ_NOT_HIGH&#160;</td><td class="fielddoc"><p>Sensor IRQ low after reset. </p>
</td></tr>
<tr><td class="fieldname"><a id="adf46f9c3966202d9cf52a82981adaea4ada84c3d206b52e8981913831a90a1588"></a>FPC_BEP_RESULT_SENSOR_IRQ_NOT_LOW&#160;</td><td class="fielddoc"><p>Sensor IRQ high after irq clear. </p>
</td></tr>
</table>

</div>
</div>
<a id="a58f034417a4e1bc9cef9137aa3aa031f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a58f034417a4e1bc9cef9137aa3aa031f">&#9670;&nbsp;</a></span>fpc_bep_sensor_driver_mechanism_t</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="fpc__bep__types_8h.html#a58f034417a4e1bc9cef9137aa3aa031f">fpc_bep_sensor_driver_mechanism_t</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>FPC sensor driver mechanism. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a58f034417a4e1bc9cef9137aa3aa031fa3e90c53c3d1bd719b55d76ba61b9cadc"></a>FPC_BEP_INTERRUPT_DRIVEN&#160;</td><td class="fielddoc"><p>Sensor HW interrupt. </p>
</td></tr>
<tr><td class="fieldname"><a id="a58f034417a4e1bc9cef9137aa3aa031fa66e4a6dd9f2298b114c777a8275817a0"></a>FPC_BEP_POLLING&#160;</td><td class="fielddoc"><p>Sensor polling. </p>
</td></tr>
</table>

</div>
</div>
<a id="ac4da354010b9012ce2767da249de35b9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac4da354010b9012ce2767da249de35b9">&#9670;&nbsp;</a></span>fpc_bep_sensor_reset_t</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="fpc__bep__types_8h.html#ac4da354010b9012ce2767da249de35b9">fpc_bep_sensor_reset_t</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>FPC sensor reset type. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ac4da354010b9012ce2767da249de35b9a6ef0de25d7da74f58a3861c55453da3d"></a>FPC_BEP_HARD_RESET&#160;</td><td class="fielddoc"><p>Hard reset via sensor reset signal. </p>
</td></tr>
<tr><td class="fieldname"><a id="ac4da354010b9012ce2767da249de35b9a0f5403529d3469496a55aeb2cffe640f"></a>FPC_BEP_SOFT_RESET&#160;</td><td class="fielddoc"><p>Soft reset via sensor SPI command. </p>
</td></tr>
</table>

</div>
</div>
<a id="aa6e74077b38c2f61ddf287bc03c09579"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa6e74077b38c2f61ddf287bc03c09579">&#9670;&nbsp;</a></span>fpc_bep_sensor_state_after_release_t</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="fpc__bep__types_8h.html#aa6e74077b38c2f61ddf287bc03c09579">fpc_bep_sensor_state_after_release_t</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>FPC sensor state after BEP release. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="aa6e74077b38c2f61ddf287bc03c09579aed3aaff12a171843c6c8764d4ce7718f"></a>FPC_BEP_SENSOR_DEEP_SLEEP&#160;</td><td class="fielddoc"><p>Leave sensor in deep sleep after BEP Release. Default. </p>
</td></tr>
<tr><td class="fieldname"><a id="aa6e74077b38c2f61ddf287bc03c09579a951113e4e4d7d91308aa134fdb8e6806"></a>FPC_BEP_SENSOR_SLEEP&#160;</td><td class="fielddoc"><p>Leave sensor in armed sleep. Sensor will issue an IRQ on finger touch </p>
</td></tr>
<tr><td class="fieldname"><a id="aa6e74077b38c2f61ddf287bc03c09579ae8d27b2d96c9ea3db354b9f3066d5dda"></a>FPC_BEP_SENSOR_IDLE&#160;</td><td class="fielddoc"><p>Leave sensor in idle/active mode. </p>
</td></tr>
</table>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_0188a3e6da905bc60aceb35bf790b8c9.html">api</a></li><li class="navelem"><a class="el" href="dir_d218fd71c02742082feaad64e43c1ecd.html">inc</a></li><li class="navelem"><a class="el" href="fpc__bep__types_8h.html">fpc_bep_types.h</a></li>
    <li class="footer">Generated on Tue Nov 9 2021 12:12:59 for Biometric Embedded Platform by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
</body>
</html>
